Operation Document.ReplacePermission (Replace Permission)

In component org.nuxeo.ecm.core.automation.coreContrib

Description

Replace a given permission on the input document(s). Returns the document(s).

Operation id	Document.ReplacePermission
Category	Document
Label	Replace Permission
Requires
Since

Parameters

Name	Description	Type	Required	Default value
id	ACE id.	string	yes
permission	ACE permission.	string	yes
username	ACE target user/group.	string	yes
acl	ACL name.	string	no	local
begin	ACE begin date.	date	no
comment	Comment	string	no
end	ACE end date.	date	no
notify	Notify the user or not	boolean	no

Signature

Inputs	document, documents
Outputs	document, documents

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.document.ReplacePermission
Contributing Component	org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.ReplacePermission",
  "label" : "Replace Permission",
  "category" : "Document",
  "requires" : null,
  "description" : "Replace a given permission on the input document(s). Returns the document(s).",
  "url" : "Document.ReplacePermission",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "id",
    "description" : "ACE id.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "permission",
    "description" : "ACE permission.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "username",
    "description" : "ACE target user/group.",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "acl",
    "description" : "ACL name.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "local" ]
  }, {
    "name" : "begin",
    "description" : "ACE begin date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "comment",
    "description" : "Comment",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "end",
    "description" : "ACE end date.",
    "type" : "date",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "notify",
    "description" : "Notify the user or not",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}